4.3.2.3 编辑组织架构-基于外部id
可通过此接口在用户目录编辑组织架构。
基本信息
请求地址:
https://SDPC-IP:4433/api/v3/group/updateByExternalId
请求方式:
POST
请求头(Header)
- 请求体(Body)
参数 | 中文名称 | 必须 | 类型 | 描述 |
---|---|---|---|---|
directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识,在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local 。外部用户目录示例: custom01339 (唯一标识无需携带@) |
externalId | 外部id | 是 | string | 示例:81dc9bdb52d04dc2 |
group | 所属组织架构 | 否 | object | |
├─ key | 组织架构唯一标识 | 否 | string | 通过此标识,来关联对应组织架构。 存在 group 参数时,此参数必传。 取值范围: id -组织架构idfullPath -组织架构全路径externalId -组织架构外部id |
├─ data | 组织架构唯一标识对应值 | 否 | string | 存在 group 参数时,此参数必传。 示例: id :1345c177-e4f6-11ee-835b-fefcfeefe529fullPath :/客服体系/专家中心/零信任专家组externalId :202cb962ac59075b964b07152d234b70 |
description | 描述信息 | 否 | string |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/group/updateByExternalId?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"directoryDomain": "custom01339",
"externalId": "81dc9bdb52d04dc2",
"description": "业务组A",
"group": {
"key": "fullPath",
"data": "/客服体系/专家中心/零信任专家组"
}
}'
- 返回数据
参数 | 中文名称 | 类型 | 描述 |
---|---|---|---|
code | 响应码 | string | OK 表示成功,其他表示出错。具体含义请参考错误码定义 |
data | 响应数据 | object | |
msg | 描述信息 | string | |
traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {},
"msg": "请求成功",
"traceId": "00f2e29b9e1669d7"
}
错误码